/*
 *  Copyright 2008 Mark Ashworth <javameme@gmail.com>.
 * 
 *  Licensed under the GNU General Public License v3 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.gnu.org/licenses/gpl-3.0.html
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */
package xperiment.metaphor.persistence.user;

import org.dom4j.Element;
import org.springframework.dao.DataAccessException;
import xperiment.metaphor.persistence.*;
import xperiment.metaphor.model.user.User;

/**
 * User Data Access Object
 * @author Mark Ashworth <javameme@gmail.com>
 * @version 1.0.0
 */
public interface UserDao extends Dao<User> {
    /**
     * Retrieves the user by userName
     * @param name The userName
     * @return User or null is not found
     */
    User retrieveByName(String name);
    /**
     * @deprecated Used in the old Tapestry application, will be removed
     */
    boolean checkLogin(String userName, String password);
    
    /**
     * Persists the object
     * @param element The element to persist
     * @return The persisted object
     * @throws DataAccessException If there was an database error
     */
    User persistXML(Element element);
}
